AtomicX Core API/io.trtc.tuikit.atomicxcore.api.live

Package-level declarations

Types

data class AVStatistics(var userID: String = "", var videoBitrate: Int = 0, var videoWidth: Int = 0, var videoHeight: Int = 0, var frameRate: Int = 0, var audioSampleRate: Int = 0, var audioBitrate: Int = 0)

Audio and video statistics information

BattleConfig

data class BattleConfig(var duration: Int = 0, var needResponse: Boolean = false, var extensionInfo: String = "")

PK configuration information set when sending a PK request

BattleEndedReason

enum BattleEndedReason : Enum<BattleEndedReason>

Reason for PK ending received by users in an ongoing PK

BattleInfo

data class BattleInfo(val battleID: String = "", val config: BattleConfig = BattleConfig(), val startTime: Long = 0, val endTime: Long = 0)

PK information

BattleListener

abstract class BattleListener

PK-related callback events received

BattleRequestCallback

interface BattleRequestCallback

PK request callback

BattleState

data class BattleState(var currentBattleInfo: StateFlow<BattleInfo?>, var battleUsers: StateFlow<List<SeatUserInfo>>, var battleScore: StateFlow<Map<String, Int>>)

PK-related state data provided by BattleStore

BattleStore

abstract class BattleStore

直播 PK 管理相关接口，管理 PK 的创建、加入、离开等操作。

CoGuestState

data class CoGuestState(val connected: StateFlow<List<SeatUserInfo>>, val invitees: StateFlow<List<LiveUserInfo>>, val applicants: StateFlow<List<LiveUserInfo>>, val candidates: StateFlow<List<LiveUserInfo>>)

Co-guest related state data provided externally by CoGuestStore

CoGuestStore

abstract class CoGuestStore

Live co-guest management related interfaces, managing co-guest application, invitation, acceptance, rejection and other operations between hosts and audience.

CoHostLayoutTemplate

enum CoHostLayoutTemplate : Enum<CoHostLayoutTemplate>

Connection layout template

CoHostListener

abstract class CoHostListener

Connection request callback events

CoHostState

data class CoHostState(val coHostStatus: StateFlow<CoHostStatus>, val connected: StateFlow<List<SeatUserInfo>>, val invitees: StateFlow<List<SeatUserInfo>>, val applicant: StateFlow<SeatUserInfo?>, val candidatesCursor: StateFlow<String>, val candidates: StateFlow<List<SeatUserInfo>>)

Cross-room connection related state data provided externally by CoHostStore

CoHostStatus

enum CoHostStatus : Enum<CoHostStatus>

Current user's cross-room connection status

CoHostStore

abstract class CoHostStore

Live host connection management related interfaces, managing creation, joining, leaving and other operations for host-to-host connections.

DeviceControlPolicy

enum DeviceControlPolicy : Enum<DeviceControlPolicy>

Device control policy

GuestListener

abstract class GuestListener

Callback events received on guest side

HostListener

abstract class HostListener

Callback events received on host side

LikeListener

abstract class LikeListener

Like event, used to receive like dynamics in live rooms/voice chat rooms.

LikeState

data class LikeState(val totalLikeCount: StateFlow<Long>)

Like state, used to display and subscribe to like information in live rooms/voice chat rooms.

LikeStore

abstract class LikeStore

Like related interfaces, managing like sending, like state synchronization, and like event listening operations in live rooms/voice chat rooms.

LiveAudienceListener

abstract class LiveAudienceListener

Live audience events

LiveAudienceState

data class LiveAudienceState(val audienceList: StateFlow<List<LiveUserInfo>>, val audienceCount: StateFlow<Int>, val messageBannedUserList: StateFlow<List<LiveUserInfo>>)

Live audience state

LiveAudienceStore

abstract class LiveAudienceStore

Live audience related interfaces, managing audience list, permission settings and other operations.

LiveCanvas

data class LiveCanvas(var w: Int = 0, var h: Int = 0, var templateID: Int = 600)

Live canvas

LiveEndedReason

enum LiveEndedReason : Enum<LiveEndedReason>

Live ended reason.

LiveInfo

data class LiveInfo(var liveID: String = "", var liveName: String = "", var notice: String = "", var isMessageDisable: Boolean = false, var isPublicVisible: Boolean = true, var isSeatEnabled: Boolean = true, var keepOwnerOnSeat: Boolean = false, var maxSeatCount: Int = 0, var seatMode: TakeSeatMode = TakeSeatMode.APPLY, var seatLayoutTemplateID: Int = 600, var coverURL: String = "", var backgroundURL: String = "", var categoryList: List<Int> = emptyList(), var activityStatus: Int = 0, val liveOwner: LiveUserInfo = LiveUserInfo(), val createTime: Long = 0, var totalViewerCount: Int = 0, var isGiftEnabled: Boolean = true, var metaData: Map<String, String> = emptyMap())

Live information

LiveInfoCompletionHandler

interface LiveInfoCompletionHandler

Live info completion callback interface.

LiveKickedOutReason

enum LiveKickedOutReason : Enum<LiveKickedOutReason>

Kicked out of live room reason.

LiveListListener

abstract class LiveListListener

Live list events

LiveListState

data class LiveListState(val liveList: StateFlow<List<LiveInfo>>, val liveListCursor: StateFlow<String>, val currentLive: StateFlow<LiveInfo>)

Live list state

LiveListStore

abstract class LiveListStore

Live list related interfaces, managing live room creation, joining, leaving and other operations.

LiveSeatListener

abstract class LiveSeatListener

Seat related callback events.

LiveSeatState

data class LiveSeatState(val seatList: StateFlow<List<SeatInfo>>, val canvas: StateFlow<LiveCanvas>, val speakingUsers: StateFlow<MutableMap<String, Int>>, val avStatistics: StateFlow<List<AVStatistics>>)

Seat state data provided by LiveSeatStore.

LiveSeatStore

abstract class LiveSeatStore

Live seat management related interfaces, managing seat operations such as taking seat, leaving seat, locking seat, and releasing seat.

LiveSummaryData

data class LiveSummaryData(var totalDuration: Long = 0, var totalViewers: Int = 0, var totalGiftsSent: Int = 0, var totalGiftUniqueSenders: Int = 0, var totalGiftCoins: Int = 0, var totalLikesReceived: Int = 0, var totalMessageSent: Int = 0)

LiveSummaryState

data class LiveSummaryState(val summaryData: StateFlow<LiveSummaryData>)

LiveSummaryStore

abstract class LiveSummaryStore

LiveUserInfo

data class LiveUserInfo(var userID: String = "", var userName: String = "", var avatarURL: String = "")

Live user information

MetaDataCompletionHandler

interface MetaDataCompletionHandler

Metadata completion callback interface.

MoveSeatPolicy

enum MoveSeatPolicy : Enum<MoveSeatPolicy>

Move seat policy

NoResponseReason

enum NoResponseReason : Enum<NoResponseReason>

Reason for no response to co-guest invitation sent by host or co-guest request initiated by audience

RegionInfo

data class RegionInfo(var x: Int = 0, var y: Int = 0, var w: Int = 0, var h: Int = 0, var zorder: Int = 0)

Seat view coordinate information

Role

enum Role : Enum<Role>

User role.

SeatInfo

data class SeatInfo(var index: Int = 0, var isLocked: Boolean = false, var userInfo: SeatUserInfo = SeatUserInfo(), var region: RegionInfo = RegionInfo())

Seat information

SeatUserInfo

data class SeatUserInfo(val userID: String = "", val userName: String = "", val avatarURL: String = "", val role: Role = Role.GENERAL_USER, val liveID: String = "", val microphoneStatus: DeviceStatus = DeviceStatus.OFF, val allowOpenMicrophone: Boolean = true, val cameraStatus: DeviceStatus = DeviceStatus.OFF, val allowOpenCamera: Boolean = true, val userSuspendStatus: SuspendStatus = SuspendStatus.NONE)

Seat user information

StopLiveCompletionHandler

interface StopLiveCompletionHandler

Stop live completion callback interface.

SuspendStatus

enum SuspendStatus : Enum<SuspendStatus>

User suspend status

TakeSeatMode

enum TakeSeatMode : Enum<TakeSeatMode>

Take seat mode.